Document status	35 - Reviewed

The purpose of this document is to describe the schema used by the Advanced VEE API. It currently only contains one API, the Estimation API.

Estimation API

Request Body: EC -> ML VEE

Property Name	Datatype	Comment
RequestId	string	Id used to trace the request from Energy Connect to the Estimation App
CompanyIdentification	string	Used to identify the owner of the request and who to sent it back to.
MeterId	Integer	The id of the Meter that needs estimations. Has to be the same as the ids of the timeseries data stored in the module
Quadrant	ENUM ( A14, A23 )	On which quadrant an estimation is needed. Usage or Production
TimeGapStart	DateTime YYYY-MM-DDThh:mm:ssZ	The start of the gap that needs to be estimated. Formatted like this 2024-04-13T08:30:00Z meaning the 13th of April 2024 at half past 8 in UTC.
TimeGapEnd	DateTime YYYY-MM-DDThh:mm:ssZ	The end of the gap that needs to be estimated. Exclusive. Formatted like TimeGapStart
TotalQuantity	Nullable	WIP The total quantity at the end of the TimeGap. Could be null if total quantity is unknown
TimeSeriesInterval	Enum ( 1h, 15min )	In what resolution the result needs to be in. "Timeværdier" eller "kvartersværdier"

Response Body: ML VEE -> EC

Property Name	Datatype	Comment
Status	Enum ( Success, Failure )	WIP A result status for the estimation. It's either Successfull and a result is returned. A unexpected failure. Or ML VEE is unable because of missing data and EC has to fallback.
Type	Enum (ML, SevenDays)	WIP The quality of the Estimation. Was Machine Learning used or different fallback
Description	string	A text field with a description of the status. Could be used for debug logging, usage in the frontend or similar
TimeSeries	Array of TimeSeries	The estimated timesseries. See below table for dataformat

TimeSeries

Property Name	Datatype	Comment
TimeStamp	DateTime YYYY-MM-DDThh:mm:ssZ
Quantity	Float	The estimated quantity since last timestamp is requested interval. (1h, 15min)